home *** CD-ROM | disk | FTP | other *** search
-
- Help File for The Archive Server
- ============================================================================
-
- First the Credits,
- than a quick pragmatic help section,
- then a more formal and detailed help section.
-
- ==========================================================================
-
- Welcome to the University of Illinois's Smalltalk Archive.
-
- Brought To You By
-
- Professor Ralph E. Johnson
- Graduate Student William E. Voss
-
-
- Additional Goodies Brought To You By
-
- The Manchester Smalltalk Archive
- Mario Wolczko
- Alan Wills
-
- The International Smalltalk Association
- Library Committee
- K. C. Wong (Chair)
-
-
- And Most Importantly
-
- The Numerous Programmers Who Have Made Their Code Available
-
- ==========================================================================
- The archive server run at st.cs.uiuc.edu was written by Michael DeCorte
- with minor local modifications by William Voss. The original source is
- available from archive-server@sun.soe.clarkson.edu.
- ==========================================================================
- The files under the directory ISA are contributed and maintained by the
- "International Smalltalk Association" Library Committee.
- If you need to communicate with a human: isa@st.cs.uiuc.edu
- ==========================================================================
- The directory MANCHESTER is a mirror of the Manchester Smalltalk Archive.
- European users should access Manchester directly with the message.
- To: goodies-lib@cs.man.ac.uk
- Subject: help; index
- They also mirror our archive, so you won't be missing anything.
- If you need to communicate with a human: lib-manager@cs.man.ac.uk
- ==========================================================================
- The other directories are maintained here at Illinois. The files in this
- archive are available via anonymous ftp from st.cs.uiuc.edu which is
- currently an alias for speedy.cs.uiuc.edu at [128.174.241.10].
- They are also available via an email based server.
-
- This document describes the email server.
-
- If you need to communicate with a human: archive-management@st.cs.uiuc.edu
- ============================================================================
-
- Pragmatic Help Section.
-
- ============================================================================
- You have probably figured out by now that this Smalltalk archive
- is available via anonymous ftp at st.cs.uiuc.edu, and via an
- email server at archive-server@st.cs.uiuc.edu.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- You probably received this file because you sent a line containing
- help
- to archive-server, or because the server had problems with
- some other request you sent.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- To get the list of all files, include the line:
- send ls-lR
- as part of your message, or if you are an aspiring guru the lines:
- archiver shar
- encoder uuencode
- encodedsend ls-lR.Z
- which will uuencode an already compressed listing, and place
- it in a shell archive for you. Note that "archiver" and
- "encoder" should be listed before any "send" lines.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Finding Files (Hints)
-
- The file ls-lR contains a recursive directory listing of the
- entire archive. It is updated every night. (ls-lR.Z is the same
- file compressed.)
-
- The file MANCHESTER/CATALOGUE contains descriptive information for
- almost every SMALLTALK file in the archive. It does not list
- files under the ISA directory, and it does not list non-Smalltalk
- files such as those under papers/. However it does include files
- under st80_r4/ st80_pre4/ and st_v/. Such files are listed as
- uiuc/st_r4/ uiuc/st80_pre4/ and uiuc/st_v respectively. The
- other files are all listed relative to MANCHESTER/.
-
- So to get both you would include the lines
- send ls-lR
- send MANCHESTER/CATALOGUE
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Unquestionably the most popular commands are:
- send <archive> <file..>
- encodedsend <archive> <file...>
- On this system
- archive ::= ISA | MANCHESTER | docs | gnu_st | little_st | papers |
- st80_pre4 | st80_r4 | st_v | tmp | ts | <white space>
- file ::= filename | directory/<file>
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Note that the "encodedsend" command is RECURSIVE.
- So given the ls-lR listing:
-
- st80_pre4/Foible/FlowKit:
- total 134
- -rw-r--r-- 1 src 283 Jul 5 1990 FlowKit2-PP.bld
- -rw-r--r-- 1 src 1620 May 14 1990 FlowKit2-PPfix.st
-
- The following commands should be roughly equivalent
- encodedsend st80_pre4/Foible/FlowKit
- or
- encodedsend st80_pre4 Foible/FlowKit
- or the two line
- encodedsend st80_pre4/Foible/FlowKit/FlowKit2-PP.bld
- encodedsend st80_pre4/Foible/FlowKit/FlowKit2-PPfix.st
- or the two line
- encodedsend st80_pre4 Foible/FlowKit/FlowKit2-PP.bld
- encodedsend st80_pre4 Foible/FlowKit/FlowKit2-PPfix.st
-
- However, this is not equivalent
- encodedsend st80_pre4 Foible FlowKit/FlowKit2-PP.bld
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- You will often see listings like this:
-
- st80_pre4/Foible:
- total 759
- drwxr-xr-x 3 src 512 Mar 14 00:15 FlowKit
- -rw-r--r-- 1 src 57257 Mar 14 00:22 FlowKit.tar.Z
-
- The FlowKit.tar.Z file is a compressed tar of the
- FlowKit directory. Either get one or the other,
- there should be no need to get both.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- So bringing all that together, if you want to
- fetch the FlowKit.tar.Z file send the message.
-
- To: archive-server@st.cs.uiuc.edu
- Subject:
-
- path yourname@your.internet.address
- archiver tar
- encoder uuencode
- encodedsend st80_pre4/Foible/FlowKit.tar.Z
- size 100000
- ============================================================================
-
- Long more formal version of help.
-
- ============================================================================
- Copyright 1989, 1990 Michael DeCorte
- Modified 1991,1992 by Bill Voss for the st.cs.uiuc.edu Smalltalk archive.
- ============================================================================
- The archive server is a program that gives you the ability to retrieve
- files via electronic mail. It is a very dumb program with little
- error detection. Thus if you make mistakes, you won't get what you
- wanted. This also means that you can ask it to do unreasonable
- things, but please don't.
-
- To make the archive server do something you should send an electronic
- mail message to archive-server@st.cs.uiuc.edu The body of the message
- should consist of one command per line. The case of the commands does
- not matter.
-
- The archive is grouped together via directories. Each directory is
- considered an archive. Associated with each archive is an index file
- as well as a top level index file that lists all of the archives.
- You can find out what archives are available with the command "index."
-
- Supported commands:
-
- help
-
- Sends you this file.
-
- path <mail-path>
-
- "Path" is used to override the mail path that the archive server
- chooses from the header of your mail message. You should use this
- whenever you know that the return address of your message will not
- be useful to the archive server. The archive server only knows
- about domain style address. This means that the archive-server
- understands name@site.bitnet and name@site.edu and name@site.UUCP
- but does not understand name@site. If you have any doubts about
- your mail address, you should ask your system administrator for a
- correct domain style address. An example use of "path" is
-
- path mrd@sun.soe.clarkson.edu
-
- index [archive...]
-
- "Index" mails to you a listing of the files in the specified
- archives. If an archive is not specified, then the index of the
- available archives will be sent.
- The command "send ls-lR" will send a recursive listing of the
- entire st.cs.uiuc.edu archive.
-
- send <archive> <file..>
-
- "Send" mails to you the files in the specified archive. All of
- the files that you request will be sent to you archived together
- (see "archiver"), possibly packed (see "pack"), possibly encoded
- (see "encoder") and split up into messages that are small enough
- to be mailed (see "size"). If you specify an archive and do not
- specify any files, then all of the files in that archive will be
- sent. You may have as many "sends" in the body of your mail
- message as you wish. If you can use one of the "encoders" you
- should always use encodedsend instead.
-
- encodedsend <archive> <file...>
-
- "Encodedsend" is identical to the command "send" except that the
- files are guaranteed to be encoded (see "encoder"). This is
- useful if you know that the return message will go through EBCDIC
- based computers.
-
- archiver <archiving-method>
-
- You may specify the method of archiving (merging a group of files
- into one large file) the files with "archiver". By default, files
- that are mailable are simply stuck together with the text "cut
- here" between files and; non-mailable files are archived via unix
- tar. The available archiving methods are:
-
- none (the files are simply stuck together)
- shar (Unix sh script)
- simple (the files are separated by "cut here" - default)
- tar (Unix Tar - default and suggested for non mailable files)
-
- pack <packing-method>
-
- You may specify that the files be packed (compressed) before
- delivery. This has the advantage that the mail files will be
- smaller. By default the files are not packed. The available
- packing methods are:
-
- compress (the Unix command compress)
- compact (the Unix command compact - slower than compress)
- none
-
- encoder <encoding-method>
-
- Non-mailable files must be converted to something mailable. By
- default this is done with "uuencode". You may also specify that
- the files must be encoded with the command "encodedsend." The
- available encoding methods are:
-
- btoa
- uuencode (default)
-
- size <max-file in bytes>
-
- The archive server splits files up so that they are smaller than
- this limit. This is done because many sites have a maximum mail
- size limit. A value of 0 means that there is no limit. The
- archive server has a default size limit of 100000 bytes. You may
- change this if you know that you have different limits. Most (but
- not all) uucp sites have a limit of 100000 bytes. Internet and
- Bitnet sites should set this to 300000 bytes.
-
- length <number>
-
- Many mailers will truncate long lines. To overcome this the
- archive server encodes files that contains lines that are longer
- than 130 characters (see "encoder"). If you know that your mail
- files will not be truncated then you can set this value to
- something larger.
-
- limit <number>
-
- The archive-server limits the amount of data that will be returned
- by any one request. This limit is very large. By using this command
- you may lower this limit. This is typically done to prevent errors
- by the user.
-
- search <string> <archive> <file...>
-
- You may search through the archive for a string. A string is
- considered to be any sequence of alphanumeric characters; case
- does not matter. If you only provide an archive name then all of
- the files in the archive will be searched. You will be returned
- all lines that contain the string.
-
- find <string...>
-
- You may search for file names that contain the given string. Case
- is significant in the string. You will be returned all file names
- that match the given string.
-
- language <string>
-
- This will allow you to change the language that the help files are in
- to the named language. English is the only supported language right
- now though so this command doesn't really do anything yet.
-
-
- EXAMPLE
-
- Here is an example message that you could send to the archive-server.
- It gives (a somewhat absurd) example of all the supported commands.
-
- ------
- help
- language english
- path mrd@sun.soe.clarkson.edu
- index st80_pre4
- archiver tar
- pack compress
- encoder btoa
- encodedsend gnu_st/smalltalk-1.1.tar.Z
- size 200000
- length 80
- search resume texhax texhax.89.001 texhax.89.002
- find resume
- -----
-
- A more realistic example for users with access to UNIX based systems is.
-
- ------
- path yourname@your.internet.address
- archiver tar
- encoder uuencode
- pack compress
- encodedsend st80_r4
- encodedsend MANCHESTER/manchester/4.0
- ------
- For this example, you would then need to combine the messages you receive
- into a single file, and edit the line which reads something like
- begin 666 1206.outgoing
- to instead read
- begin 666 1206.tar.Z
-
- As you probably realize, you then
- uudecode your_concatenated_file
- uncompress 1206.tar.Z
- tar -xvf 1206.tar
- ============================================================================
-
- APPENDIX
-
- 1) Files are considered mailable if they do not have any lines longer
- than 130 characters and do not have any characters other than tabs,
- carriage returns, newlines, vertical tabs, formfeeds and characters
- between space through tilde (using ascii ordering).
-
- 2) If you have problems or questions, you should send mail to
- archive-management@st.cs.uiuc.edu.
-
- 3) If you have an archiving, packing, encoding program that runs under
- BSD Unix that I do not have and you would like me to support then
- please send it to me. It is very easy to incorporate it into this
- package.
-
- 4) The archive server was written by Michael DeCorte. It consists of
- a groups of bourne shell and awk scripts designed to work under BSD
- Unix based computers. There are no restrictions on its redistribution
- provided the copyright notice is left intact.
-
- 5) Send mail to archive-server@sun.soe.clarkson.edu if you want the
- original archive-server source.
-
- 6) Unix is a registered trademark of AT&T.
- ============================================================================
-